'\" te
.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH MP_GETOBJECTTYPE 3MPAPI "Feb 15, 2006"
.SH NAME
MP_GetObjectType \- get an object type
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <mpapi.h>

\fBMP_STATUS\fR \fBMP_GetObjectType\fR(\fBMP_OID\fR \fIoid\fR, \fBMP_OBJECT_TYPE\fR \fI*pObjectType\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIoid\fR\fR
.ad
.RS 15n
The initialized object ID to have the type determined.
.RE

.sp
.ne 2
.na
\fB\fIpObjectType\fR\fR
.ad
.RS 15n
A pointer to an object ID that has type \fBMP_OBJECT_TYPE\fR variable allocated
by the caller. With a successful return it contains the object type of
\fIoid\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBMP_GetObjectType()\fR function gets the object type of an initialized
object ID.
.sp
.LP
This API is provided so that clients can determine the type of object an object
ID represents.  This can be very useful for a client function that receives
notifications.
.SH RETURN VALUES
.sp
.ne 2
.na
\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
.ad
.sp .6
.RS 4n
The \fIoid\fR does not specify any valid object type. This is most likely to
happen if an uninitialized object ID is passed to th e API.
.RE

.sp
.ne 2
.na
\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
.ad
.sp .6
.RS 4n
The \fIpObjectType\fR is null or specifies a memory area to which data cannot
be written.
.RE

.sp
.ne 2
.na
\fB\fBMP_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The operation is successful.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	T{
Standard: ANSI INCITS 412 Multipath Management API
T}
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR libMPAPI (3LIB),
.BR MP_RegisterForObjectVisibilityChanges (3MPAPI),
.BR attributes (7)
.sp
.LP
\fIMultipath Management API Version 1.0\fR
